| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

DeflateEncoder.h
1 // DeflateEncoder.h
3 //
5
6 namespace nkMemory
7 {
11 enum class DEFLATE_BLOCK_TYPE
12 {
13 // Only used internally
14 } ;
15
19 struct DeflateOutputStorage final
20 {
21 // Only used internally
22 } ;
23 }
24
25 namespace nkMemory
26 {
33 class DeflateEncoder
34 {
35 public :
36
37 // Constructor, destructor
41 DeflateEncoder () noexcept ;
47 DeflateEncoder (BitStream data) noexcept ;
51 DeflateEncoder (BufferView<> data) noexcept ;
52
53 // Setters
63 void setDataStream (BitStream data) ;
73 void setTransientOutput (BufferView<> output) ;
74
75 // Decompression
84 BufferView<> decode () ;
94 BufferView<> decode (BufferView<> output) ;
98 bool isDecodingDone () const ;
99 } ;
100 }
nkMemory::DeflateEncoder
An encoder supporting Inflate/Deflate compression.
Definition: DeflateEncoder.h:34
nkMemory::DeflateEncoder::decode
BufferView decode()
nkMemory::DeflateEncoder::setDataStream
void setDataStream(BitStream data)
nkMemory::DeflateEncoder::isDecodingDone
bool isDecodingDone() const
nkMemory::BitStream
Offers capabilities to read data bit per bit.
Definition: BitStream.h:12
nkMemory::DeflateEncoder::setTransientOutput
void setTransientOutput(BufferView<> output)
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkMemory::DEFLATE_BLOCK_TYPE
DEFLATE_BLOCK_TYPE
Used internally to keep track of the current block type.
Definition: DeflateEncoder.h:12
nkMemory::DeflateOutputStorage
Used internally to keep track of the output buffer status.
Definition: DeflateEncoder.h:20
nkMemory::DeflateEncoder::DeflateEncoder
DeflateEncoder() noexcept
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7